/********************************************************************************
 * Project Name		[JavaSE_Fundamentals]
 * File Name     	[Comments.java]
 * Creation Date 	[2015-01-01]
 * 
 * Copyright© ge.y.yang@gmail.com All Rights Reserved
 * 
 * Work hard, play harder, think big and keep fit
 ********************************************************************************/
package basicGrammar;

/**
 * Java的类注释<br/>
 * 
 * @author 不落的太阳(Sean Yang)
 * @version 1.0
 * @since jdk 1.8
 * @see {@linkplain HelloJavaWorld#main(String[] args) HelloJavaWorld}
 * @deprecated
 */
@Deprecated
public class Comments {

	/**
	 * Java的属性注释
	 */
	protected String propertyComments;

	/**
	 * Java的方法注释
	 * 
	 * @param value
	 *            参数
	 * @return 返回类型
	 * @throws RuntimeException
	 *             抛出的异常
	 */
	protected int method(int value) throws RuntimeException {
		return value;
	}

	// 包注释:
	// 提供一个以package-info命名的Java文件, 其必须在包语句之后包含一个初始的以/**和*/界定的Javadoc注释
	// 而且不能包含更多的代码和注释

	// 生成Java Doc
	// 解决编码问题: -encoding utf-8 -charset utf-8 -J-Xmx256m.
	// -d file_location 指定保存路径
	// -author 指定作者
	// -version 指定版本
}
